CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /user-config (Post)
In This Topic
    Post/user-config
    In This Topic
    Description
    creates or modifies a user
    Request (application/json)

    The request body is of type object.

    Overview

    Projects : Array[CimProjectUser]
    ProjectID : string
    The Id or name of the project.
    ProjectPath : string
    full absolute path to project specified in ProjectID
    User : CimUser
    Fields that describe the user
    AuthenticationType : CimUserType
    Enable : boolean
    set it to true to enable the user.
    PasswordExpiresInDays : number
    password expires in number of configured days.
    Password : string
    Password for the user.
    Resources : Array[string]
    An array of resources that mapped to the user.
    RoleID : string
    The Id of role.
    UserID : string
    The Id of user.
    UserName : string
    The name of user.
    200 Response

    The response body is of type ItemsPostResponse.

    The collection of results from the object create/update operation

    Overview

    ItemsPostResponse
    The results of the create/update/delete operations.
    NumSuccesses : number
    The number of items that were successfully written.
    NumFailures : number
    The number of items that failed to be written.
    WarningsMask : integer
    a bitmask of warning conditions (e.g., WarningLicensePointCount)
    ItemResults : Array[ItemResult]
    The results for each item in the request array.
    Success : boolean
    high level result (success true, failure false)
    StatusDetails : integer
    a value giving more details about the status (e.g., SuccessNew, SuccessModified, FailureDupInRequest, FailureDupInObject, and then a bunch of FailureXyzzy, ...)
    WarningsMask : integer
    a bitmask of warning conditions (e.g., IE_SNF_NO_GLB_TRIG_MSG)
    Message : string
    (localized?) message about the result, probably empty for successes
    Fault Responses
    FaultDescription
    This fault returns a response body of type ProblemDetails.
    General Error
    See Also